GET api/property/{id}/documents?subTypes[0]={subTypes[0]}&subTypes[1]={subTypes[1]}&pageSize={pageSize}&pageNumber={pageNumber}&type={type}
Get the documents of a property by the property Id
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The id of the property to get the documents for |
integer |
Required |
| subTypes | Collection of string |
Required |
|
| pageSize | integer |
Default value is 20 |
|
| pageNumber | integer |
Default value is 1 |
|
| type | string |
None. |
Body Parameters
None.
Response Information
Resource Description
A list of documents for the property or null if the property does not exist
PagedCollectionDataContractOfDezrez.Core.DataContracts.External.Api.Media.DocumentDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalCount | integer |
None. |
|
| CurrentCount | integer |
None. |
|
| PageSize | integer |
None. |
|
| PageNumber | integer |
None. |
|
| Collection | Collection of Dezrez.Core.DataContracts.External.Api.Media.DocumentDataContract |
None. |
Response Formats
application/json, text/json
Sample:
{
"TotalCount": 1,
"CurrentCount": 2,
"PageSize": 1,
"PageNumber": 1,
"Collection": [
{
"Url": "sample string 1",
"RequiresAuthentication": true,
"ExpiryDate": "2024-05-08T23:43:31.2891451Z",
"FileStream": null,
"Tags": [
{
"Name": "sample string 1",
"SystemStatusName": "sample string 2",
"TagType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Id": 3
},
{
"Name": "sample string 1",
"SystemStatusName": "sample string 2",
"TagType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Id": 3
}
],
"DocumentType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"DocumentSubType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FileName": "sample string 3",
"ContentType": "sample string 4",
"FileExtension": "sample string 5",
"Description": "sample string 6",
"FileSize": "sample string 7",
"CreatedDate": "2024-05-08T23:43:31.2891451Z",
"CreatedBy": {
"Initials": "sample string 1",
"ContactName": "sample string 2",
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Title": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"PrimaryTelephone": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"PrimaryEmail": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"JobTitle": "sample string 6",
"Id": 7
},
"Id": 9
},
{
"Url": "sample string 1",
"RequiresAuthentication": true,
"ExpiryDate": "2024-05-08T23:43:31.2891451Z",
"FileStream": null,
"Tags": [
{
"Name": "sample string 1",
"SystemStatusName": "sample string 2",
"TagType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Id": 3
},
{
"Name": "sample string 1",
"SystemStatusName": "sample string 2",
"TagType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Id": 3
}
],
"DocumentType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"DocumentSubType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FileName": "sample string 3",
"ContentType": "sample string 4",
"FileExtension": "sample string 5",
"Description": "sample string 6",
"FileSize": "sample string 7",
"CreatedDate": "2024-05-08T23:43:31.2891451Z",
"CreatedBy": {
"Initials": "sample string 1",
"ContactName": "sample string 2",
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Title": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"PrimaryTelephone": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"PrimaryEmail": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"JobTitle": "sample string 6",
"Id": 7
},
"Id": 9
}
]
}